LEADTOOLS Image File Support (Leadtools.Codecs assembly)
LEAD Technologies, Inc

WriteComments(String,Int32,RasterCollection<RasterCommentMetadata>) Method






A System.String that contains the file name.
1-based index of the page at which to write the comment.
A collection of Leadtools.RasterCommentMetadata objects containing the comments data.
Writes one or more comments to an existing file. .NET support
Syntax
public void WriteComments( 
   string fileName,
   int pageNumber,
   RasterCollection<RasterCommentMetadata> comments
)
'Declaration
 
Public Overloads Sub WriteComments( _
   ByVal fileName As String, _
   ByVal pageNumber As Integer, _
   ByVal comments As RasterCollection(Of RasterCommentMetadata) _
) 
'Usage
 
Dim instance As RasterCodecs
Dim fileName As String
Dim pageNumber As Integer
Dim comments As RasterCollection(Of RasterCommentMetadata)
 
instance.WriteComments(fileName, pageNumber, comments)
public void WriteComments( 
   string fileName,
   int pageNumber,
   RasterCollection<RasterCommentMetadata> comments
)
 function Leadtools.Codecs.RasterCodecs.WriteComments(String,Int32,RasterCollection{RasterCommentMetadata})( 
   fileName ,
   pageNumber ,
   comments 
)
public:
void WriteComments( 
   String^ fileName,
   int pageNumber,
   RasterCollection<RasterCommentMetadata^>^ comments
) 

Parameters

fileName
A System.String that contains the file name.
pageNumber
1-based index of the page at which to write the comment.
comments
A collection of Leadtools.RasterCommentMetadata objects containing the comments data.
Remarks

This function only applies to TIF, uncompressed EXIF, or FPX files.

When you add or remove tags, the tags array at the end of the file is re-written. When you modify existing tags, the new tag value is added to the file and the IFD is modified as necessary. In all of these cases, there is no image recompression.

Some restrictions apply to this function if you use an IFD to indicate to which page to write the comment. See the Loading And Saving Large TIFF Files topic for more information.

Example
For an example, refer to ReadComment(String,Int32,RasterCommentMetadataType).
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

RasterCodecs Class
RasterCodecs Members
Overload List
Implementing Exif Features
Implementing TIFF Comments and Tags
Working with Markers

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.